home *** CD-ROM | disk | FTP | other *** search
/ More SimCities / More SimCities (1997).iso / sc / tools / simtools / map.doc < prev    next >
Text File  |  1997-06-17  |  11KB  |  331 lines
  1.  
  2.  
  3.  
  4.  
  5.           MAP                    Ed's Utility Manual                    MAP
  6.  
  7.  
  8.           SUMMARY
  9.  
  10.                map -- prints character based map of a SIMCITY city file
  11.  
  12.           PARAMETERS
  13.  
  14.                map [-lsde] [-f outfile] cityfile
  15.  
  16.           DESCRIPTION
  17.  
  18.                Map examines a SIMCITY saved game (.CTY file) and prints a
  19.                schematic diagram of the city, along with some vital
  20.                statistics.
  21.  
  22.                Map makes two passes over the .cty file.  First, zones of
  23.                all types are counted, and animated zones are repaired with
  24.                the non-animated tiles that belong in those animated spaces.
  25.                Next, the map is printed on the systems default printer, or
  26.                optionally to a file.
  27.  
  28.           OPTIONS
  29.  
  30.                l    Use LaserJet with Line Printer font in Portrait
  31.                     orientation.  This option should work on the Series II,
  32.                     the IID, the IIP and even the DeskJet, although output
  33.                     on the deskjet will be distorted.
  34.  
  35.                s    Use LaserJet with the special font included with the
  36.                     package.  The font is found in file MAP.FNT.  This
  37.                     extends use of the program to the LaserJet Plus.  The
  38.                     font should be downloaded and made permanent.
  39.  
  40.                d    Download and use the special font. The font is
  41.                     downloaded as temporary, used to print the map, and
  42.                     cleared.  Font #1 is used.
  43.  
  44.                e    Manipulate the printer from strings found in the
  45.                     environment.  See ENVIRONMENT section below.
  46.  
  47.                f    Output to a file.  The print stream is output to the
  48.                     named file.  If the print stream contains LaserJet
  49.                     codes, or the downloaded font, these will be included
  50.                     in the file.
  51.  
  52.           HARDWARE REQUIREMENTS AND ISSUES
  53.  
  54.                Map should run on virtually any PC.  Output should be to a
  55.                printer that can display 132 columns by 99 rows.  For 132
  56.                column output you may use a printer set for compressed print
  57.                or one with wide paper.  For 99 rows, you may set a large
  58.                number of lines per inch, or allow the printout to run over
  59.                the page boundary. You may initialize the printer with a
  60.                batch file, from the front panel, or by placing printer
  61.  
  62.  
  63.  
  64.  
  65.                                        Page 1
  66.  
  67.  
  68.  
  69.  
  70.  
  71.           MAP                    Ed's Utility Manual                    MAP
  72.  
  73.  
  74.                commands in the environment.  See the ENVIRONMENT section
  75.                below for details.
  76.  
  77.                Output may be customized for the HP LaserJet.  The font
  78.                requirement is Portrait orientation, PC-8 (Also known as
  79.                IBM-US) Symbol Set, and Line Printer Font.  This font is
  80.                found in the Y cartridge, and is also permanently installed
  81.                in the Series II, IID, IIP and LaserJet 2000 printer.
  82.  
  83.                The MAP font may be used to print a map with more
  84.                specialized characters. It extends use of the program to the
  85.                LaserJet Plus, which has no Line Printer font in portrait
  86.                mode.
  87.  
  88.                The program may be used with the original LaserJet only with
  89.                the Y cartridge.
  90.  
  91.           ENVIRONMENT
  92.  
  93.                If you select the -e switch, MAP will manipulate the printer
  94.                settings taking codes from environment variables. MAP will
  95.                search for three variables:
  96.  
  97.                     MAPINIT: Sent immediately before printing.
  98.                     MAPDEINIT: Sent immediately after printing.
  99.                     MAPRESET: Sent first and last.
  100.  
  101.                In other words, the order of processing is as follows:
  102.  
  103.                     Send MAPRESET
  104.                     Send MAPINIT
  105.                     Print Map
  106.                     Send MAPDEINIT
  107.                     Send MAPRESET
  108.  
  109.                Any or all of these variables may appear.  If one does not,
  110.                the step will be skipped.
  111.  
  112.                When placing strings in the environment, certain characters
  113.                cannot be easily inserted.  These may be added with the
  114.                following special sequences. (This concept was taken from
  115.                the DOS Prompt command.)
  116.  
  117.                     $q   The = character
  118.                     $$   The $ character
  119.                     $g   The > character (greater than)
  120.                     $l   The < character (less than)
  121.                     $b   The | character (bang)
  122.                     $_   A carriage-return/line-feed pair
  123.                     $e   The Escape character
  124.                     $h   The Backspace character
  125.  
  126.                Any good editor should be able to place other control
  127.                characters in your autoexec or other batch file.
  128.  
  129.  
  130.  
  131.                                        Page 2
  132.  
  133.  
  134.  
  135.  
  136.  
  137.           MAP                    Ed's Utility Manual                    MAP
  138.  
  139.  
  140.  
  141.                For example, to send an ESCAPE-D to the printer on startup
  142.                and end, place the line
  143.  
  144.                     set MAPRESET=$eD
  145.  
  146.                in your Autoexec, and use the -e switch on the map command
  147.                line.
  148.  
  149.           BUGS
  150.  
  151.                MAP does not know about animated tiles.  The program
  152.                compensates for this by rebuilding all animated zones with
  153.                non-animated tiles before printing, therefore, if the center
  154.                of an animated zone (industry, power plant, airport, etc.)
  155.                is destroyed, and the animated portions are left behind, the
  156.                program cannot rebuild them, and will print the unknown tile
  157.                symbol.
  158.  
  159.                The program will not yet rebuild a stadium in which a game
  160.                was in progress when the game was saved.  Several unknown
  161.                tile symbols should appear.
  162.  
  163.                Power Lines are not shown when they cross roads.
  164.  
  165.                Railroad crossings are not distinguished.  The only
  166.                indication of a railroad crossing is that the rail exists on
  167.                both sides of the road.
  168.  
  169.           EXAMPLES
  170.  
  171.                                      map cityfile.cty
  172.  
  173.                Print map of cityfile.cty file the prn device.  No printer
  174.                codes sent.
  175.  
  176.                                    map -l cityfile.cty
  177.  
  178.                Print map on the prn device, expecting a LaserJet with the
  179.                Line Printer font in portrait orientation, PC-8 symbol set.
  180.  
  181.                                map -lf outfile cityfile.cty
  182.  
  183.                Write map described above on the file outfile.
  184.  
  185.                                  map -df foo cityfile.cty
  186.  
  187.                Write file named foo containing a LaserJet print image.
  188.                This will include the codes to initialize the printer,
  189.                download the MAP font (including the font data itself),
  190.                print the map, and reset everything.  NOTE:  Don't forget to
  191.                use the /B option when copying this to a printer.
  192.  
  193.                                    map -e cityfile.cty
  194.  
  195.  
  196.  
  197.                                        Page 3
  198.  
  199.  
  200.  
  201.  
  202.  
  203.           MAP                    Ed's Utility Manual                    MAP
  204.  
  205.  
  206.  
  207.                Print the map using the codes in the environment.
  208.  
  209.                                    map -s cityfile.cty
  210.  
  211.                Print the map on a LaserJet, with the expectation that the
  212.                MAP font is already downloaded.
  213.  
  214.           FEEDBACK REQUESTED
  215.  
  216.                Please feed back on the following:
  217.  
  218.                Did you have any problem with the environment option?
  219.  
  220.                Is the map readable and useful?
  221.  
  222.                Does it come out right? Are there any errors in it's
  223.                portrayal of your cities.
  224.  
  225.                Any changes in the interface or operation desired?
  226.  
  227.                MAP writes a log of unknown tiles.  This log is written in
  228.                BADTILE.LOG in the current directory. If you get a
  229.                BADTILE.LOG, please forward it, along with the city file, to
  230.                the author, as shown below.  Exception:  If the unknown tile
  231.                is in an area of widespread devastation, or in a stadium do
  232.                not bother to report it.
  233.  
  234.           AUTHORSHIP AND COPYRIGHT
  235.  
  236.                Edward W.  Greenberg
  237.                PO Box 28618
  238.                San Jose, CA 95159
  239.                408-283-0184
  240.  
  241.                CIS: 76703,1070
  242.                USENET: edg@cso.3mail.3com.com
  243.                        edg@netcom.com
  244.  
  245.                This document, and the accompanying program are Copyright
  246.                1990 by Edward W. Greenberg, San Jose, California.  They may
  247.                not be reproduced for profit or gain with the exception that
  248.                a reasonable disk reproduction fee may be charged.  They may
  249.                be freely shared on diskette, on Bulletin Board Systems or
  250.                on for-profit on-line services, so long as no charge is made
  251.                for them in excess of the normal on-line charge for such
  252.                service.
  253.  
  254.                The MAP font is not copyrighted, since one cannot copyright
  255.                a font, but only a font name.  I don't claim copyright on
  256.                the name MAP as a font name.
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.                                        Page 4
  264.  
  265.  
  266.  
  267.  
  268.  
  269.           MAP                    Ed's Utility Manual                    MAP
  270.  
  271.  
  272.           SHAREWARE
  273.  
  274.                This program represents about 20 hours work.  I have made it
  275.                available on CompuServe and encourage it's distribution on
  276.                other shareware media.
  277.  
  278.                If you'd like to acknowledge the usefulness of this program,
  279.                and encourage further development of SIMCITY utilities,
  280.                please register with a $10 shareware contribution.  I'll
  281.                notify registered users of new versions and other utilities.
  282.                Whether or not you send a shareware contribution, please
  283.                drop me an electronic note, or a postcard, and let me know
  284.                that you're using the program and what you think of it.
  285.  
  286.           OTHER TRADEMARKS
  287.  
  288.                SIMCITY is a trademark of Maxis.
  289.                LASERJET and DESKJET are trademarks of Hewlett Packard, as
  290.                is HP.
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.                                        Page 5
  330.  
  331.